home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / rap100a.zip / RAP.DOC < prev    next >
Text File  |  1991-11-15  |  21KB  |  558 lines

  1.  
  2.  
  3.  
  4.              ****              *             ****
  5.              *   *            * *            *   *
  6.              ****            *****           ****
  7.              *  *            *   *           *
  8.              *   * emote     *   * ccess     *     ub!
  9.  
  10.                            Version 1.00
  11.  
  12.            (C)opyright Nov 15 1991 Bad Attitude Software
  13.  
  14.  
  15. What it is
  16. ==========
  17.  
  18. This program is based upon the "Neighborhood Pub" subsystem found on
  19. some Galacticomm/MajorBBS multiline BBS systems.  However, this version
  20. is built specifically for RemoteAccess V1.10.  It should also function
  21. on any BBS system capable of producing a DORINFO1.DEF file (and working
  22. in a multiline environment), such as QuickBBS, SuperBBS, and RBBS.
  23.  
  24. If you are running RemoteAccess V1.10 or greater, RAP also supports
  25. communications between RAP and the BBS.  See the info on the RAP.CTL
  26. file for info on how to set this up.
  27.  
  28. This is a line-oriented "chat" program.  At the prompt, you may type
  29. anything you like (up to 400 characters), and this will be "broadcast"
  30. to all users currently in the Pub.  There's also a "whisper" facility
  31. (to say something to only one other person in the Pub) and, last but not
  32. least, there are "actions".
  33.  
  34. This program can handle up to 32 nodes simultaneously and has room in
  35. the userfiles for up to 300 users.
  36.  
  37. Late breaking news: RA V1.10 mentions a new "RemoteAccess Professional"
  38. version which will include teleconferencing, but does not specify what
  39. the upgrade fee will be.  I have *ZERO* specifics on this new feature, I
  40. don't even know what it will look like nor what features it will have.
  41. Once I've seen it, I'll endeavor to duplicate any features it has that
  42. RAP lacks.  Hopefully, RAP will stay on top of this suddenly-crowded
  43. field.
  44.  
  45. The Legal Stuff
  46. ===============
  47.  
  48. This program is protected by copyright.  Bad Attitude Software reserves
  49. all rights.  You are granted the right to run this program, unmodified,
  50. on as many computer systems as you wish on a TRIAL BASIS.  If you
  51. continue to use this program after thirty (30) days, you are required by
  52. law to register it.  Registration will get you the latest version of RAP
  53. sent to you, either via electronic mail or by floppy disk.  This version
  54. will be specifically "stamped" as being registered to your BBS.
  55. Information on registration will appear at the end of this document.
  56.  
  57. Throughout this document, there are references to specific programs
  58. which are also copyrighted.  I'll try to list them all here, and my
  59. sincere apologies to anyone I miss (please let me know so I can update
  60. this document).
  61.  
  62.         QuickBBS        - ???
  63.         SuperBBS        - ???
  64.         RemoteAccess    - Continental Software
  65.         QuickBASIC      - Microsoft
  66.         MS-DOS          - Microsoft
  67.         Desqview        - QuarterDeck
  68.         QEMM            - QuarterDeck
  69.         4DOS            - JP Software Inc.
  70.         X00             - Ray Gwinn
  71.         BNU             - David Nugent
  72.         Opus!Comm       - Bit Bucket Software
  73.  
  74. This program was written in QuickBASIC (V4.5) by Joe Lindstrom.  Certain
  75. input routines and the logon screens were written/created by Racey Sealock,
  76. whose help has been invaluable (though he'll tell you otherwise).  Thanks
  77. for being there, Racey!  (and yes, that *IS* his real name!)
  78.  
  79.  
  80. Dedication
  81. ==========
  82.  
  83. This program is dedicated to the memory of Gene Roddenberry, who passed
  84. away on October 24th, 1991.  Gene was the creator of the now-legendary
  85. television show "Star Trek", which encouraged us all to go where none
  86. have gone before.  Gene's vision of a positive future, of learning to
  87. better get along with each other, and of the exciting "human adventure",
  88. was an inspiration to "Trekkers" and non-Trekkers alike.  Gene is now in
  89. "The Undiscovered Country"... he may be gone, but he will never be
  90. forgotten.
  91.  
  92. Rest in peace, Gene.
  93.  
  94.  
  95. Setting it up
  96. =============
  97.  
  98. First, you need to make sure that you have an acceptable "environment".
  99. I have tested this program under Desqview V2.34 (QEMM V5.00) with MS-DOS
  100. V5.00 and 4DOS V4.00.  It should work under other multitaskers, and it
  101. should also work on a LAN-based system.  I have tested it under
  102. LANTASTIC NOS V4.00 and it worked just fine, though since my LAN cards
  103. are not the swiftest things were a bit slow.
  104.  
  105. SHARE - SHARE.EXE comes with all versions of MS-DOS V3.1 and newer.  It
  106. *MUST* be installed.  Since I assume you already run a multi-line BBS,
  107. you probably have already done this.  If not, it is *REQUIRED*.  RAP
  108. uses disk files to communicate with other RAPPERS and if SHARE isn't
  109. loaded, RAP will barf all over you.
  110.  
  111. FOSSIL DRIVER - Again, to even RUN most of the above-named bulletin
  112. boards, you have to have a FOSSIL driver installed (FOSSIL stands for
  113. Fido/Opus/Seadog Standard Interface Layer), which is an interface
  114. between user software and the communications ports.  If you do *NOT*
  115. have one loaded, RAP will not function.  I highly recommend X00 V1.24,
  116. but others such as BNU and Opus!Comm will also work.  If you are running
  117. under a LAN, *EACH* workstation needs to have a FOSSIL installed, even
  118. if logins will always be local (ie: not remote).  RAP makes use of a
  119. specific FOSSIL call to the ANSI driver.  If a FOSSIL is not installed,
  120. RAP's output will be invisible and you'll be typing blind.  That's a
  121. best case: on some machines, it just locks up the computer.
  122.  
  123. A note to high-speed modem users: "doorfix" programs are not required
  124. with RAP.  Because RAP uses the FOSSIL driver directly, if you are using
  125. a high-speed or other buffered modem you do *NOT* have to give RAP an
  126. artificially high baud rate if you have already "locked" the FOSSIL
  127. driver to that rate.  RAP and the FOSSIL driver will automatically send
  128. the data through the serial port at the correct rate of speed.
  129.  
  130. Now, to set it up, you should first create a subdirectory on your system
  131. for RAP to live in.  Of course, it should be accessible by all BBS nodes
  132. that will be accessing RAP.  If you're running under a LAN, set up this
  133. subdirectory on the SERVER and ensure that all workstations have full
  134. read-write privileges.
  135.  
  136. Copy all the files in this archive into this subdirectory, which, for
  137. sake of demonstration, we'll call D:\RAP.  Unless you're upgrading from
  138. V0.55ß or earlier, you can delete the 055TO060.EXE program.  If you are
  139. upgrading from V0.55ß or earlier, see the WHATSNEW file (sub-heading
  140. What's New V0.60ß) for information on using 055TO060.EXE.  Once you've
  141. finished using it, it can be destroyed.  You'll need to keep all the
  142. other .EXE files, .RAP files, .ANS files, and .ASC files.
  143.  
  144. (Note: this program requires the use of a specially-patched version of
  145. BRUN45.EXE, supplied in the archive.  If you have other programs on your
  146. system that also use BRUN45.EXE, you may simply copy this BRUN45.EXE
  147. into any other directory in your path.  This particular version is
  148. "patched" so that it will not drop DTR after exit.  All of your other
  149. programs can use this version of BRUN45.EXE, and you *ONLY* need one of
  150. them on your system).
  151.  
  152. Next, change directories (the CD command) into D:\RAP.
  153.  
  154. Type MAKERAP TOTAL
  155.  
  156. MAKERAP.EXE will create a couple of system files for RAP to use.  Typing
  157. MAKERAP by itself will show you the available options, which are:
  158.  
  159. TOTAL   - Create all-new system files.
  160. CLEAN   - Wipes only the NODEIDX file.  Useful if your system crashed
  161.           while RAP was running... if this happens, the next time
  162.           someone tries to login, they may be told "this node is already
  163.           logged in" and RAP will abort.  Running MAKERAP CLEAN will
  164.           clear up this problem.
  165.  
  166. *DO NOT RUN MAKERAP WHILE USERS ARE LOGGED INTO RAP!!!*
  167.  
  168. If you intend to run RAP under RemoteAccess and allow the two to talk to
  169. each other (further details below), you should be aware that RA tends to
  170. "garbage" its main communications file, called USERON.BBS, which is
  171. stored in the main system directory (usually defined in RACONFIG as the
  172. SYSTEM DIRECTORY).  Somehow, RA can handle this but it can confuse RAP
  173. somewhat.  There is therefore a procedure that should be done at least
  174. once, but better yet it should also be done in your AUTOEXEC.BAT or your
  175. MIDNIGHT.BAT as well.  A provided program, WIPEUSER.EXE, is designed to
  176. "blank" the USERON.BBS file (be sure nobody is online before you run it!).
  177.  
  178. CD into your main RA directory and run it there... you can just type
  179. WIPEUSER to format space for 32 nodes, or you can type WIPEUSER followed
  180. by a number (from 1 to 99) to format space for that number of nodes.  I
  181. strongly recommend that you do not use a value less than 32 for use with
  182. the RAP program.
  183.  
  184.  
  185. Once you've done all of this, you're almost ready to roll.  The
  186. following instructions apply to both RemoteAccess and QuickBBS.  If
  187. you're running something else, read the instructions and apply them to
  188. your own setting.
  189.  
  190. You'll need to build a menu option to activate RAP.  Either a TYPE 7 or
  191. a TYPE 15 will work, and TYPE 15 is recommended.  If you use a TYPE 7,
  192. have it call a batch file to do the batch instructions below.  A good
  193. idea would be something like this:
  194.  
  195. TYPE 7
  196.  
  197. *C /c RAP*N.BAT
  198.  
  199. *N will be translated to the current BBS node number.  If the user is on
  200. node 1, RAP1.BAT will be called.  Etc.
  201.  
  202. The following batch instructions will appear in RAP?.BAT if you're using
  203. TYPE 7, or in your main BBSLINEx.BAT if you're using a TYPE 15.
  204.  
  205. D:
  206. CD \RAP
  207. RAP RAP.CTL C:\BBS\LINE1\DORINFO1.DEF 1
  208. C:
  209. CD \BBS\LINE1
  210.  
  211. This of course assumes that your main BBS files are in C:\BBS\LINE1 and
  212. that this batch file is for node 1.  RAP requires three command-line
  213. parameters.  The first is the filename (full path if necessary) for the
  214. RAP.CTL file.  Usually one file will work fine for all of your nodes but
  215. if you want to enable different stuff for different lines, make several
  216. RAP.CTL files (name them whatever you like) and specifically name them
  217. on the appropriate batch file command line.  The second parameter is the
  218. full path to the DORINFO1.DEF file for the current node, and the third
  219. is the node number.  They *GOTTA* be different, folks: you can't have
  220. two people logging on as node 1!  It becomes *VERY* important if, by
  221. using RAP.CTL appropriately, you configure RAP-to-BBS communications:
  222. the node number that RAP uses *MUST* repeat *MUST* match the node number
  223. that the BBS that spawned it thinks it is: if not, undefined things will
  224. happen and I take *NO* responsibility.  If line 1 calls RAP, RAP should
  225. be told that it is line 1.  Etc.
  226.  
  227. If you run into any other weird problems with RAP, I'd recommend:
  228.  
  229. - Increasing your FILES= setting in CONFIG.SYS.
  230. - Ensuring that RAP can find USERS.RAP and NODEIDX.RAP as well as all
  231.   the other associated *.RAP files.
  232. - Making sure you've run WIPEUSER at least once (see above instructions,
  233.   applies to RA systems).
  234.  
  235. Assuming all the RAP files (RAP.ANS, HELP.ANS, etc.) are located in the
  236. current directory, everything will work just spiffy-like!  User
  237. instructions are built-in (examples are contained in HELP.ANS and HELP.ASC).
  238.  
  239.  
  240. RAP.CTL
  241. =======
  242.  
  243. This file ESSENTIALLY contains optional information but it *MUST* be
  244. present, even if the file is blank (be sure there's at least one line,
  245. even if it's just a carriage return).  Three parameters can be defined
  246. in RAP.CTL (or whatever name you use, see above), as follows:
  247.  
  248. RAPATH d:\path\
  249.  
  250. This tells RAP two things: that you are using it with RemoteAccess V1.10
  251. or greater, and that the d:\path\ directory is where it can find
  252. USERON.BBS and the various NODExx.RA files, which are all needed for
  253. communicating with the BBS (and vice versa).  This is the directory
  254. defined in RACONFIG as your SYSTEM DIRECTORY.  If RAPATH is not defined,
  255. RAP assumes no RemoteAccess capabilities.
  256.  
  257. RapWorkPath d:\path\
  258.  
  259. All RAP files are contained in whatever directory is "current" when RAP
  260. loads.  This includes the user file, help files, and whatnot.
  261. *HOWEVER*, some sysops have asked that they be able to put some of this
  262. stuff on a RAMDISK.  That can be dangerous, but there is *ONE* file that
  263. is both used a great deal *AND* contains no "permanent" information, so
  264. it's a PERFECT candidate for a nice, high-speed RAMDISK.  That file is
  265. NODEIDX.RAP and is created and maintained automatically by RAP (though
  266. if it gets corrupted, you'll need to run MAKERAP CLEAN in whichever
  267. directory it resides in).  You could define RapWorkPath to your RAMDISK
  268. and let all the RAP nodes use the RAMDISK for faster inter-RAP
  269. communications.  Remember, though, that *EVERY* RAP node needs to be
  270. able to access the *SAME* NODEIDX.RAP file: if you're running on a LAN,
  271. be damned sure that RapWorkPath points to a directory that ALL nodes can
  272. access.
  273.  
  274. Bell (ON or OFF)
  275.  
  276. Some sysops were annoyed at ASCII-007 characters being printed at the
  277. local console, which of course rings the bell.  BELL OFF will turn this
  278. off (locally only, it will still ring remotely).  BELL ON leaves it on.
  279.  
  280. One command per line please!
  281.  
  282.  
  283. Maintenance
  284. ===========
  285.  
  286. Once per day, you should:
  287.  
  288. D:
  289. CD \RAP
  290. RAPMAINT 45
  291.  
  292. The 45 is an arbitrary number, any number from 1 to 300 will do.  This
  293. will increment all the day counters in the USERS.RAP file, and delete
  294. anyone over 45 (or the number you specify) days old.  Users that aren't
  295. using RAP will therefore take no room in the userfile.  Although I have
  296. *NOT* tested this, RAPMAINT should work just fine even if users happen
  297. to be using RAP at the time.
  298.  
  299.  
  300. Extra features
  301. ==============
  302.  
  303. The WHISPER facility works something like this (assuming you are JOE)
  304.  
  305. You type:
  306.  
  307. /FRED hey, how ya doin' today?
  308.  
  309. This message will be sent *ONLY* to Fred.
  310.  
  311. Fred will see:
  312.  
  313. Joe *whispers* to you: hey, how ya doin' today?
  314.  
  315. Additionally, partial names will work (and they'll also work with
  316. ACTIONS as described below).  For example, this would get you the same
  317. thing as the above:
  318.  
  319. /FR hey, how ya doin' today?
  320.  
  321. RAP will match /FR with the first online user who's name begins with FR.
  322.  
  323.  
  324. Typing ? or HELP brings up an online help screen
  325.  
  326. Typing WHO, NODES and LOOKUP bring up different user lists (which, since
  327. they're long, can be aborted by pressing the S key).
  328.  
  329. Typing PAGE (if configured under RemoteAccess) will let you page BBS
  330. users.  If the user happens to also be in RAP, it will function
  331. something like a whisper in that *ONLY* the "target" node will receive
  332. the message.  If the user is elsewhere in the BBS, RAP will use the
  333. RemoteAccess facilities for passing messages between BBS users.
  334.  
  335. Typing ACTIONS gives a list of available actions.
  336.  
  337. If the sysop enters F1, 1 minute will be added to the user's time.
  338.  
  339. If the sysop enters F2, 1 minute will be deducted from the user's time.
  340.  
  341. If the sysop enters F10, the user will be thrown out of the Pub (this
  342. works only after the user has actually entered the Pub).
  343.  
  344.  
  345. There's a few other things you can add to RAP.
  346.  
  347.  
  348. RAP News
  349. ========
  350.  
  351. If NEWS.ASC exists in the RAP subdirectory, it will be displayed to
  352. users just before they "sit down in the Pub".  If you want to give your
  353. users special instructions, or the latest news on whatever, edit this
  354. file and they'll see it every time (abortable by pressing "S").  Note
  355. that if your user supports ANSI, and NEWS.ANS is available, they'll see
  356. this file instead.  In other words, you can make NEWS.ANS and NEWS.ASC
  357. and the "appropriate" file will be displayed... if only NEWS.ASC exists,
  358. it will be displayed to both types of user.
  359.  
  360.  
  361. Actions
  362. =======
  363.  
  364. Here is where the fun starts.  An "action" is a verb that you define
  365. that has special meaning to RAP.  It's best to explain this by example,
  366. so here goes:
  367.  
  368. If you (JOE) type:
  369.  
  370. KICK FRED
  371.  
  372. Then Fred will see:
  373.  
  374. Joe just kicked you!
  375.  
  376. And everyone else will see:
  377.  
  378. Joe just kicked Fred!
  379.  
  380. Or, perhaps you just want to type:
  381.  
  382. SMILE
  383.  
  384. In which case, everyone (except you of course) will see:
  385.  
  386. Joe is smiling.
  387.  
  388. Etc.  This is all sysop-configurable.  The distribution archive contains
  389. some samples that are a good starting point, and you can modify them
  390. and/or add to them all you like.
  391.  
  392. There are two types of actions, regular and talktype.  They are stored,
  393. respectively, in ACTION.RAP and TALKTYPE.RAP in your RAP subdirectory.
  394. These files have an *EXACT* format and you will find RAP to be very very
  395. unforgiving if you mess this up: it will abort with a nasty error
  396. message and refuse to run.  So get 'em right.
  397.  
  398. In each file, a given action definition takes up four lines.  Here are
  399. the brief descriptions (might be a good idea to examine the sample files
  400. that I've included so that you can better visualize this).
  401.  
  402. ACTION.RAP
  403.  
  404. Line 1 - The actual verb itself
  405. Line 2 - The text to display locally when this verb is used
  406. Line 3 - The output text if this verb is used BY ITSELF
  407. Line 4 - The output text if this verb is used with a username
  408.  
  409. %m ("me") can be used to tell RAP where to put the user's name
  410. %y ("you") can be used to tell RAP where to put the name of the user
  411.    towards whom this verb is directed.
  412.  
  413. Example:
  414.  
  415. smile
  416. Gosh, aren't you nice?
  417. %m is smiling pleasantly.
  418. %m is smiling pleasantly at %y.
  419.  
  420. Now, if you were to then type:
  421.  
  422. SMILE
  423.  
  424. You would see:
  425.  
  426. Gosh, aren't you nice?
  427.  
  428. Everyone else would see:
  429.  
  430. Joe is smiling pleasantly.
  431.  
  432. If you had typed:
  433.  
  434. SMILE FRED
  435.  
  436. Fred would see:
  437.  
  438. Joe is smiling pleasantly at you.
  439.  
  440. And everyone else would see
  441.  
  442. Joe is smiling pleasantly at Fred.
  443.  
  444. The word "ALL" can be used as a username, in which case all users would
  445. see:
  446.  
  447. Joe is smiling pleasantly at everyone.
  448.  
  449. Pretty easy?  Good.
  450.  
  451. n/a, if used alone on either line 3 or line 4, disables that function.
  452. For example, PHASER might be a good thing to do to someone, but PHASER
  453. by itself makes little sense, so you'd N/A the third line.
  454.  
  455. Next is TALKTYPE.RAP.  The format is virtually identical, with the
  456. following differences:
  457.  
  458. Line 4 - Prompt modifier.  Will be surrounded by "From " and ": "
  459.  
  460. The %y variable is invalid.
  461.  
  462. Example:
  463.  
  464. sing
  465. Do, Re, Mi!
  466. %m is singing to himself.
  467. %m, singing
  468.  
  469. If you then type:
  470.  
  471. sing
  472.  
  473. Everyone sees:
  474.  
  475. Joe is singing to himself.
  476.  
  477. But if you type:
  478.  
  479. sing Deck The Halls...
  480.  
  481. Everyone will see:
  482.  
  483. From Joe, singing: Deck The Halls...
  484.  
  485.  
  486. As with whisper mode, these actions will also accept a partial username
  487. in place of a full name.  If you PHASER J, and the first user who's name
  488. begins with J is "Joe", then Joe gets phasered.  You may also PHASER
  489. ALL, in which case RAP will report that "everyone" got phasered.
  490.  
  491. And that's about that!  The possibilities are endless.  Well, almost
  492. endless.  You are restricted to a maximum of 100 ACTION.RAP definitions
  493. and 20 TALKTYPE.RAP definitions.
  494.  
  495.  
  496. Profiles
  497. ========
  498.  
  499. Personal Actions: The user can define up to 4 actions (as above) that
  500.                   *ONLY* that user may use.
  501.  
  502. Handle: Let's you change your Handle.
  503.  
  504. Desc: Change your Description (shown to others with LOOKUP)
  505.  
  506.  
  507. Configurable Login/Help Screens
  508. ===============================
  509.  
  510. The login screens (RAP.ANS and RAP.ASC) and the help screens (HELP.ASC
  511. and HELP.RAP) are disk files contained in the RAP directory.  Although I
  512. recommend that you leave them as they are, they *CAN* be edited by you.
  513. One idea might be to add the name of your BBS on the login screens
  514. (although your users will be told by RAP that they are on "Fred's BBS",
  515. if that's the name of your board, anyways).
  516.  
  517.  
  518. Registration
  519. ============
  520.  
  521. Yeah, the lousy part.
  522.  
  523. If you find this program useful, and/or you use it for more than thirty
  524. (30) days, you gotta register it.  Sorry!  Grin!
  525.  
  526. Anyways, here's the deal.  Registration is $20 in *CANADIAN* currency.
  527. I cannot cash American dollar cheques, nor British Pounds or Italian
  528. Lira for that matter.  If you're not in Canada, a money order will do
  529. the trick.  If you're in Canada, you also have the option of sending a
  530. cheque drawn on a Canadian bank.
  531.  
  532. Please make cheques and money orders payable to:
  533.  
  534. Joe Lindstrom
  535. 34 Harvest Wood Link N.E.
  536. Calgary, AB, Canada
  537. T3K 3X8
  538.  
  539. Canadian orders please add $1.40 GST (Registration Number R129367801)
  540.  
  541. The latest version of RAP is downloadable from, and installed online on,
  542. The Telekon BBS, which you can (as of this writing) dial at:
  543.  
  544. Line 1 - (403)-226-1157 (HST/V32, up to 14400 baud)
  545. Line 2 - (403)-226-1158 (MNP5, up to 2400 baud)
  546.  
  547. You can also send FTSC-style "netmail" to me if you're in either
  548. GoodEggNet or MetroNet.  My addresses are:
  549.  
  550. GoodEggNet 99:9305/55 and 99:9305/90
  551. FantasyNet 111:1110/55 and 111:1110/90
  552. MetroNet 201:5500/55 and 201:5500/90
  553.  
  554. It can be file-requested with the "magic" filename RAP
  555.  
  556. I hope you enjoy RAPPING with your users!
  557.  
  558.